Skip to content

Add CONTRIBUTING.md - #31

Merged
PrimeBuild-pc merged 1 commit into
PrimeBuild-pc:mainfrom
IG-ABHINAV:docs/contributing
Nov 13, 2026
Merged

PrimeBuild-pc merged 1 commit into
PrimeBuild-pc:mainfrom
IG-ABHINAV:docs/contributing

Conversation

@IG-ABHINAV

Copy link
Copy Markdown
Contributor

Closes #28.

What this adds

A short, root-level CONTRIBUTING.md covering everything the issue asks for:

  • Build and test commands β€” the exact commands from the README/CI (dotnet restore, dotnet build, dotnet test TweakHub.Tests), plus the dependency-free hardware-collector checks.
  • Translations (six languages) β€” where the .resx files live (Resources/<Domain>.<culture>.resx, domains UI/Tweaks/Tools/Scripts/Security/Devices/Maintenance), how strings are read (L.Get, {loc:Loc}), and the rules LocalizationTests enforces (same keys everywhere, non-blank, matching placeholders, no untranslated English).
  • Adding an External Tools card β€” Services/ShortcutService.cs β†’ LoadExternalTools(): unique name, approved category, exactly one of WingetId or HTTPS DownloadUrl, description key in all six Tools files, and the ShortcutServiceTests constraints.
  • The tweak rule β€” preview + automatic backup + verification + rollback for every built-in tweak, RiskLevel badges, and the pinned id list in TweakCatalogueTests.
  • Reporting a hardware problem β€” Scripts/Collect-TweakHub-Hardware.cmd and docs/hardware-reports.md (what to share and what to include).
  • PR expectations β€” branch from main, keep the diff focused, no generated binaries, list the commands run.

Consolidation check

The repo had no CONTRIBUTING.md, AGENTS file or other contribution guide. The only related material is the README's Build from source, CI/CD and Hardware reports sections and docs/hardware-reports.md; the new file links to those instead of duplicating them. Docs only β€” no code, no workflow changes.

Commands run (all documented commands, executed)

Host: Windows Server 2022 (build 20348), .NET SDK 10.0.404.

Command Result
dotnet restore TweakHub.sln exit 0 β€” TweakHub.csproj and TweakHub.Tests.csproj restored
dotnet build TweakHub.sln -c Release --no-restore exit 0 β€” Build succeeded, 0 Warning(s), 0 Error(s) (26.68s)
dotnet test TweakHub.Tests/TweakHub.Tests.csproj -c Release --no-build --no-restore exit 0 β€” discovers 413 tests, runs none: No test is available … TweakHub.Tests.dll. The projects target net10.0-windows10.0.22000.0, so the NUnit host refuses to execute below build 22000 (Only supported on Windows10.0.22000.0). CI on windows-2022 produces the same output and is green.
powershell.exe -NoProfile -File Tests/HardwareCollector.Tests.ps1 exit 0 β€” Hardware collector tests passed (payload syntax, tokens, hardware IDs, safe section failures).

Every file link in CONTRIBUTING.md (LICENSE, README.md#build-from-source, Scripts/Collect-TweakHub-Hardware.cmd, docs/hardware-reports.md) resolves in the repository.

@PrimeBuild-pc
PrimeBuild-pc merged commit f783fdb into PrimeBuild-pc:main Nov 13, 2026
1 check passed
@PrimeBuild-pc

Copy link
Copy Markdown
Owner

Merged, thank you @IG-ABHINAV! I checked the commands, paths and test names against the repo and CI and they all match, and the translation and External Tools sections are exactly what new contributors will need. Closing #28 with this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a CONTRIBUTING.md

2 participants